
Last update: 2011-09-22

SmashMiner is an example application demonstrating game development using
Qt cross-platform framework, Open GL ES 2, Pulse Audio and GStreamer.
It is primarily designed to run in a mobile device, but it also contains code
enabling it to be ran on a workstation environment (e.g. during additional
development).

Overview of the game structure can be found from the tutorial documentation
that is located under doc/ folder. If you are planning to modify the game
or to create new applications based on the game, the tutorial gives you
starting points. Source and header file comments contain further technical
details about the implementation.

Background starscape graphics are public domain from Nasa Astronomy Picture
of the Day Archive (http://apod.nasa.gov/); only non-copyrighted images were
used.

Game music "Oikophobia" is composed by Toni Kurkimäki (toni@synamusic.com).

Game sound effects are from SoundEffectPack.com; please note that you will
need to obtain a licence from them if you wish to use the effects in your own
games.

SmashMiner has been tested during september 2011 to comply with the following
Harmattan platform components:

	N9 Operating system image

HTML documentation for SmashMiner can be generated using Doxygen.
If you don't have Doxygen installed, you can install it with:

$ sudo apt-get install doxygen

Doxygen uses LaTeX for document generation; LaTeX can be installed e.g with:

$ sudo apt-get install texlive 

The following commands then generate the documentation to ./smashminer/doc/
folder:

$ cd smashminer
$ doxygen Doxyfile

You can then open the file ./smashminer/doc/html/index.html to browse
the html documentation, e.g. (if you are using Firefox browser):

$ firefox doc/html/index.html

---
END
